<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: data_format_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdata__format__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">data_format_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information about a data format. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a67ebc26b36fad8bbe721c9f65b77b93d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67ebc26b36fad8bbe721c9f65b77b93d"></a>
<a class="el" href="pro_8h.html#a56f1a81c92849566ae864511088eb7e8">int32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a67ebc26b36fad8bbe721c9f65b77b93d">cbsize</a></td></tr>
<tr class="memdesc:a67ebc26b36fad8bbe721c9f65b77b93d"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of this structure <br /></td></tr>
<tr class="separator:a67ebc26b36fad8bbe721c9f65b77b93d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3ab0a40a4a3bce97271fb46708b944d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3ab0a40a4a3bce97271fb46708b944d"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a></td></tr>
<tr class="memdesc:aa3ab0a40a4a3bce97271fb46708b944d"><td class="mdescLeft">&#160;</td><td class="mdescRight">user-defined data to be passed to callbacks <br /></td></tr>
<tr class="separator:aa3ab0a40a4a3bce97271fb46708b944d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a439e0ff26331d56f8995ab634f7b21e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a439e0ff26331d56f8995ab634f7b21e8"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a439e0ff26331d56f8995ab634f7b21e8">props</a></td></tr>
<tr class="memdesc:a439e0ff26331d56f8995ab634f7b21e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">properties (currently 0) <br /></td></tr>
<tr class="separator:a439e0ff26331d56f8995ab634f7b21e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83d482dde654e19f1b74fef2922e0556"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83d482dde654e19f1b74fef2922e0556"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a83d482dde654e19f1b74fef2922e0556">name</a></td></tr>
<tr class="memdesc:a83d482dde654e19f1b74fef2922e0556"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format name, must be unique. <br /></td></tr>
<tr class="separator:a83d482dde654e19f1b74fef2922e0556"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f79a6e4fa3b1a1efb96fb84f9015624"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f79a6e4fa3b1a1efb96fb84f9015624"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a9f79a6e4fa3b1a1efb96fb84f9015624">menu_name</a></td></tr>
<tr class="memdesc:a9f79a6e4fa3b1a1efb96fb84f9015624"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visible format name to use in menus if NULL, no menu item will be created. <br /></td></tr>
<tr class="separator:a9f79a6e4fa3b1a1efb96fb84f9015624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a1bca214d3f3ee2171211bafff77ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0a1bca214d3f3ee2171211bafff77ef"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#ad0a1bca214d3f3ee2171211bafff77ef">hotkey</a></td></tr>
<tr class="memdesc:ad0a1bca214d3f3ee2171211bafff77ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hotkey for the corresponding menu item if NULL, no hotkey will be associated with the menu item. <br /></td></tr>
<tr class="separator:ad0a1bca214d3f3ee2171211bafff77ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a484363fae7730c346c2f9488ac0d16f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a484363fae7730c346c2f9488ac0d16f6"></a>
<a class="el" href="pro_8h.html#adbc570541d9f9a0c4489f9f1fe5f5699">asize_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a484363fae7730c346c2f9488ac0d16f6">value_size</a></td></tr>
<tr class="memdesc:a484363fae7730c346c2f9488ac0d16f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of the value in bytes 0 means any size is ok data formats that are registered for standard types (dtid 0) may be called with any value_size (instruction operands only) <br /></td></tr>
<tr class="separator:a484363fae7730c346c2f9488ac0d16f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a090ec0dfa9be4ba580d38f0a07453458"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a090ec0dfa9be4ba580d38f0a07453458"></a>
<a class="el" href="pro_8h.html#a56f1a81c92849566ae864511088eb7e8">int32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a090ec0dfa9be4ba580d38f0a07453458">text_width</a></td></tr>
<tr class="memdesc:a090ec0dfa9be4ba580d38f0a07453458"><td class="mdescLeft">&#160;</td><td class="mdescRight">Usual width of the text representation This value is used to calculate the width of the control to display values of this type. <br /></td></tr>
<tr class="separator:a090ec0dfa9be4ba580d38f0a07453458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5bad612e2e8fc2c59d4a5a215fddf21"><td class="memItemLeft" align="right" valign="top">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#ae5bad612e2e8fc2c59d4a5a215fddf21">print</a> )(void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *out, const void *value, <a class="el" href="pro_8h.html#adbc570541d9f9a0c4489f9f1fe5f5699">asize_t</a> size, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num, int dtid)</td></tr>
<tr class="memdesc:ae5bad612e2e8fc2c59d4a5a215fddf21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert to colored string.  <a href="#ae5bad612e2e8fc2c59d4a5a215fddf21">More...</a><br /></td></tr>
<tr class="separator:ae5bad612e2e8fc2c59d4a5a215fddf21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0336b9ad3c7d8a707d0fe1a2bcfeaf3"><td class="memItemLeft" align="right" valign="top">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#ac0336b9ad3c7d8a707d0fe1a2bcfeaf3">scan</a> )(void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="classbytevec__t.html">bytevec_t</a> *value, const char *input, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num, <a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *errstr)</td></tr>
<tr class="memdesc:ac0336b9ad3c7d8a707d0fe1a2bcfeaf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert from uncolored string.  <a href="#ac0336b9ad3c7d8a707d0fe1a2bcfeaf3">More...</a><br /></td></tr>
<tr class="separator:ac0336b9ad3c7d8a707d0fe1a2bcfeaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a405ca626635f15131422f2d67fa9b178"><td class="memItemLeft" align="right" valign="top">void(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__format__t.html#a405ca626635f15131422f2d67fa9b178">analyze</a> )(void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num)</td></tr>
<tr class="memdesc:a405ca626635f15131422f2d67fa9b178"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analyze custom data format occurrence This callback can be used to create xrefs from the current item.  <a href="#a405ca626635f15131422f2d67fa9b178">More...</a><br /></td></tr>
<tr class="separator:a405ca626635f15131422f2d67fa9b178"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ae5bad612e2e8fc2c59d4a5a215fddf21"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * data_format_t::print) (void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *out, const void *value, <a class="el" href="pro_8h.html#adbc570541d9f9a0c4489f9f1fe5f5699">asize_t</a> size, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num, int dtid)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert to colored string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ud</td><td>user-defined data </td></tr>
    <tr><td class="paramname">out</td><td>output buffer. may be NULL </td></tr>
    <tr><td class="paramname">value</td><td>value to print. may not be NULL </td></tr>
    <tr><td class="paramname">size</td><td>size of value in 8-bit bytes </td></tr>
    <tr><td class="paramname">current_ea</td><td>current address (BADADDR if unknown) </td></tr>
    <tr><td class="paramname">operand_num</td><td>current operand number </td></tr>
    <tr><td class="paramname">dtid</td><td>custom data type id (0-standard built-in data type) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success </dd></dl>

</div>
</div>
<a class="anchor" id="ac0336b9ad3c7d8a707d0fe1a2bcfeaf3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * data_format_t::scan) (void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="classbytevec__t.html">bytevec_t</a> *value, const char *input, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num, <a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *errstr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert from uncolored string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ud</td><td>user-defined data </td></tr>
    <tr><td class="paramname">value</td><td>output buffer. may be NULL </td></tr>
    <tr><td class="paramname">input</td><td>input string. may not be NULL </td></tr>
    <tr><td class="paramname">current_ea</td><td>current address (BADADDR if unknown) </td></tr>
    <tr><td class="paramname">operand_num</td><td>current operand number (-1 if unknown) </td></tr>
    <tr><td class="paramname">errstr</td><td>buffer for error message </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success </dd></dl>

</div>
</div>
<a class="anchor" id="a405ca626635f15131422f2d67fa9b178"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * data_format_t::analyze) (void *<a class="el" href="structdata__format__t.html#aa3ab0a40a4a3bce97271fb46708b944d">ud</a>, <a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> current_ea, int operand_num)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Analyze custom data format occurrence This callback can be used to create xrefs from the current item. </p>
<p>This callback may be missing. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ud</td><td>user-defined data </td></tr>
    <tr><td class="paramname">current_ea</td><td>current address (BADADDR if unknown) </td></tr>
    <tr><td class="paramname">operand_num</td><td>current operand number </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bytes_8hpp.html">bytes.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
